/*
 * Copyright 2020 The edap Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.edap.protobuf.annotation;

import io.edap.protobuf.wire.Syntax;

import java.lang.annotation.*;

/**
 * 作为protocol bufferMessage的注解
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Inherited
@Documented
public @interface ProtoMessage {
    /**
     * 生成protobuf message时的注释信息
     *
     * @return
     */
    String comment() default "";

    /**
     * Protocol Buffer的协议版本
     *
     * @return
     */
    Syntax syntax() default Syntax.PROTO_3;

    /**
     * 协议ID
     *
     * @return
     */
    int value();
}